<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class TagUtils</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class TagUtils</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">TagUtils class</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_mvc---util---TagUtils.php.html">/mvc/util/TagUtils.php</a> (line <span class="field">34</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																				<div class="method-definition">
					static 						<span class="method-result">message</span>
										<a href="#message" title="details" class="method-name">message</a>
											(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">bundle</span>&nbsp;<span class="var-name">$bundle</span>, <span class="var-type">locale</span>&nbsp;<span class="var-name">$locale</span>, <span class="var-type">key</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">args</span>&nbsp;<span class="var-name">$args</span>)
									</div>
																
												<div class="method-definition">
											<span class="method-result">current</span>
										<a href="#getUserLocale" title="details" class="method-name">getUserLocale</a>
											(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">locale</span>&nbsp;<span class="var-name">$locale</span>)
									</div>
																								<div class="method-definition">
											<span class="method-result"><a href="../mvc/MessageResources.html">MessageResources</a></span>
										<a href="#retrieveMessageResources" title="details" class="method-name">retrieveMessageResources</a>
											(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">bundle</span>&nbsp;<span class="var-name">$bundle</span>, <span class="var-type">checkPageScope</span>&nbsp;<span class="var-name">2</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodmessage" id="message"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method message</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Look up and return a message string, based on the specified  parameters.</p>
	<ul class="tags">
				<li><span class="field">return:</span> string</li>
				<li><span class="field">throws:</span> JspException if a lookup error occurs (will have been saved in                       the request already)</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">message</span>
		<span class="method-name">
			message
		</span>
					(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">bundle</span>&nbsp;<span class="var-name">$bundle</span>, <span class="var-type">locale</span>&nbsp;<span class="var-name">$locale</span>, <span class="var-type">key</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">args</span>&nbsp;<span class="var-name">$args</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pageContext</span>
				<span class="var-name">$pageContext</span><span class="var-description">: The PageContext associated with this request</span>			</li>
					<li>
				<span class="var-type">bundle</span>
				<span class="var-name">$bundle</span><span class="var-description">: Name of the servlet context attribute for our                     message resources bundle</span>			</li>
					<li>
				<span class="var-type">locale</span>
				<span class="var-name">$locale</span><span class="var-description">: Name of the session attribute for our user's Locale</span>			</li>
					<li>
				<span class="var-type">key</span>
				<span class="var-name">$key</span><span class="var-description">: Message key to be looked up and returned</span>			</li>
					<li>
				<span class="var-type">args</span>
				<span class="var-name">$args</span><span class="var-description">: Replacement parameters for this message</span>			</li>
				</ul>
		
			
	</div>

<a name="methodgetUserLocale" id="getUserLocale"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getUserLocale</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Look up and return current user locale, based on the specified  parameters.</p>
	<ul class="tags">
				<li><span class="field">return:</span> user locale</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">current</span>
		<span class="method-name">
			getUserLocale
		</span>
					(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">locale</span>&nbsp;<span class="var-name">$locale</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">pageContext</span>
				<span class="var-name">$pageContext</span><span class="var-description">: The PageContext associated with this request</span>			</li>
					<li>
				<span class="var-type">locale</span>
				<span class="var-name">$locale</span><span class="var-description">: Name of the session attribute for our user's Locale.                     If this is <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>, the default locale key                     is used for the lookup.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodretrieveMessageResources" id="retrieveMessageResources"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">retrieveMessageResources</span> (line <span class="line-number">91</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the appropriate MessageResources object for the current module  and the given bundle.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The bundle's resources stored in some scope.</li>
				<li><span class="field">throws:</span> JspException if the MessageResources object could not be                       found.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../mvc/MessageResources.html">MessageResources</a></span>
		<span class="method-name">
			retrieveMessageResources
		</span>
					(<span class="var-type">pageContext</span>&nbsp;<span class="var-name">$pageContext</span>, <span class="var-type">bundle</span>&nbsp;<span class="var-name">$bundle</span>, <span class="var-type">checkPageScope</span>&nbsp;<span class="var-name">2</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">checkPageScope</span>
				<span class="var-name">2</span><span class="var-description">: Whether to check page scope</span>			</li>
					<li>
				<span class="var-type">pageContext</span>
				<span class="var-name">$pageContext</span><span class="var-description">: Search the context's scopes for the resources.</span>			</li>
					<li>
				<span class="var-type">bundle</span>
				<span class="var-name">$bundle</span><span class="var-description">: The bundle name to look for.  If this is                        <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>, the default bundle name is                        used.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:19 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>